Singapay Home Page
Logo Icon
  1. Payment Link
  2. Get Available Payment Method

Information

MethodPathFormatAuthentication
GETapi/v1.0/payment-link-manage/payment-methodsjsonOAuth 2.0 with Access Token

Request Details

Headers Structure

FieldValueTypeMandatoryLengthDescriptionExample
X-PARTNER-IDapi_keyAlphanumericMandatoryAPI key obtained from the merchant dashboard.b3ed7d4b-a96c-6c08-b3c7-12c3124242d9
Acceptapplication/jsonAlphabeticMandatorySpecifies JSON as the expected response format.application/json
AuthorizationBearer {bearerToken}AlphanumericMandatoryBearer token obtained from the get access token endpoint.Bearer eyJ0eXAiOiJKV1{…}

Response Details

Response Structure

FieldTypeMandatoryLengthDescriptionExample
statusNumericMandatory3HTTP Status Code.200
successBooleanMandatory1Indicates the success of the request.true
dataObjectMandatory-The main object containing payment method data.-
> payment_methodsArray ObjectMandatory-Array containing the full details of each payment method.-
>> codeStringMandatory-Unique code for the payment method.QRIS
>> nameStringMandatory-Human-readable name of the payment method.VA BRI
>> groupStringMandatory-Group/category of the payment method (e.g., qris, va).va
>> descStringConditional-A brief description of the payment method.Virtual Account BRI
> available_codesArray StringMandatory-List of available/active payment method codes (code).[ “QRIS”, “VA_BRI”, “VA_DANAMON” ]

Response Example

Success: Here’s an example of a successful response.

{
    "status": 200,
    "success": true,
    "data": {
        "payment_methods": [
            {
                "code": "QRIS",
                "name": "QRIS",
                "group": "qris",
                "desc": "QR Code Indonesian Standard"
            },
            {
                "code": "VA_BRI",
                "name": "VA BRI",
                "group": "va",
                "desc": "Virtual Account BRI"
            },
            {
                "code": "VA_DANAMON",
                "name": "VA Danamon",
                "group": "va",
                "desc": "Virtual Account Danamon"
            },
            {
                "code": "VA_MAYBANK",
                "name": "VA Maybank",
                "group": "va",
                "desc": "Virtual Account Maybank"
            }
        ],
        "available_codes": [
            "QRIS",
            "VA_BRI",
            "VA_DANAMON",
            "VA_MAYBANK"
        ]
    }
}