Skip to main content

Get Payment Session

Endpoint: GET https://api.zamp.finance/payments/v1/payment-sessions/{payment-session-id}

Response Body

KeyValueDescription
idmerchant_uNR5Kc6a2zTdfqbLsDwxUZ_06_15Payment Session Id
reference_iduNR5Kc8978hgj2zTdfqbLsDwxUZReference of merchant's systems uuid
statusinitiated, in_process, succeeded, failed, cancelledStatus of the payment session
failure_codePayment Session Failure CodesFailure code if payment session is failed or cancelled
amountfloat64 valueSource amount against which we will be collecting payment on the merchant's behalf
source_currencyString valueSource currency against which we will be collecting payment on the merchant's behalf
source_accountString valueSource wallet address of the user
payment_option_idString valuePayment Option used by the customer to make the payment
payment_option_codeString valuePayment option code for the payment option id used by the customer ("AnyWallet","Metamask","BinancePay","Rainbow","WalletConnect","QRCode")
success_redirect_urlString valueURL in string datatype where the ZAMP SDK will redirect the session to in case of success payment initiation
failure_redirect_urlString valueURL in string datatype where the ZAMP SDK will redirect the session to in case of failed payment initiation
risk_scoreString valueAML Risk Score of the user

Response JSON Representation

{
"data": {
"id": "merchant_uNR5Kc6a2zTdfqbLsDwxUZ_06_15",
"reference_id": "uNR5Kc8978hgj2zTdfqbLsDwxUZ",
"merchant_id": "merchant_9GtnphjB6rbcvwb7eP5xid_05_27",
"status": "initiated",
"failure_code": "",
"amount": 100,
"source_currency": "USD",
"source_account": "0xC8a65Fadf0e0dDAf421F28FEAb69Bf6E2E589963",
"payment_option_id": "merchant_9GthjB6rbcvwb7eP5xid_05_27",
"payment_option_code": "Metamask",
"success_redirect_url": "https://merchantWebsite.com/crypto_payment_initiated",
"failure_redirect_url": "https://merchantWebsite.com/crypto_payment_failed",
"risk_score": "lowRisk",
"created_at": "2022-06-15T06:33:20.656893Z",
"updated_at": "2022-06-15T07:12:29.476202Z",
"expires_at": "2022-06-15T07:33:20.654882583Z"
}
}