v1

latestOpenAPI 3.0.02026-07-26168846732.2 KB

Authentication

Authentication - Create

Create a new authentication for accessing our APIs from your servers.

post/authentication

Request body

authentication_idstring nullable

The unique identifier for this authentication.

profile_idstring nullable

The business profile that is associated with this authentication

amountinteger required

This Unit struct represents MinorUnit in which core amount works

currency'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL' required

The three-letter ISO 4217 currency code (e.g., "USD", "EUR") for the payment amount. This field is mandatory for creating a payment.

return_urlstring nullable

The URL to which the user should be redirected after authentication.

force_3ds_challengeboolean nullable

Force 3DS challenge.

psd2_sca_exemption_type'low_value' | 'transaction_risk_analysis'

SCA Exemptions types available for authentication

profile_acquirer_idstring nullable

Profile Acquirer ID get from profile acquirer configuration

Example request

{
  "authentication_id": "auth_mbabizu24mvu3mela5njyhpit4",
  "return_url": "https://example.com/redirect",
  "acquirer_details": {
    "acquirer_bin": "123456",
    "acquirer_merchant_id": "merchant_abc",
    "merchant_country_code": "US/34456"
  },
  "customer_details": {
    "id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
    "name": "John Doe",
    "email": "johntest@test.com",
    "phone": "9123456789",
    "phone_country_code": "+1",
    "document_details": {
      "document_number": "12345678911"
    }
  }
}

Response

Authentication created

authentication_idstring required

The unique identifier for this authentication.

merchant_idstring required

This is an identifier for the merchant account. This is inferred from the API key provided during the request

status'started' | 'pending' | 'success' | 'failed' required

client_secretstring nullable

The client secret for this authentication, to be used for client-side operations.

amountinteger required

This Unit struct represents MinorUnit in which core amount works

The three-letter ISO 4217 currency code (e.g., "USD", "EUR") for the payment amount. This field is mandatory for creating a payment.

force_3ds_challengeboolean nullable

Whether 3DS challenge was forced.

return_urlstring nullable

The URL to which the user should be redirected after authentication, if provided.

created_atstring date-time nullable

error_codestring nullable

error_messagestring nullable

If there was an error while calling the connector the error message is received here

profile_idstring nullable

The business profile that is associated with this payment

psd2_sca_exemption_type'low_value' | 'transaction_risk_analysis'

SCA Exemptions types available for authentication

profile_acquirer_idstring nullable

Profile Acquirer ID get from profile acquirer configuration

Example response

{
  "authentication_id": "auth_mbabizu24mvu3mela5njyhpit4",
  "merchant_id": "merchant_abc",
  "client_secret": "auth_mbabizu24mvu3mela5njyhpit4_secret_el9ksDkiB8hi6j9N78yo",
  "created_at": "2022-09-10T10:11:12Z",
  "error_code": "E0001",
  "error_message": "Failed while verifying the card",
  "acquirer_details": {
    "acquirer_bin": "123456",
    "acquirer_merchant_id": "merchant_abc",
    "merchant_country_code": "US/34456"
  },
  "customer_details": {
    "id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
    "name": "John Doe",
    "email": "johntest@test.com",
    "phone": "9123456789",
    "phone_country_code": "+1",
    "document_details": {
      "document_number": "12345678911"
    }
  }
}