Get payment by ID

curl --request GET \
  --url https://api.staging.payrails.io/payment/payments/{paymentId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.staging.payrails.io/payment/payments/{paymentId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.staging.payrails.io/payment/payments/{paymentId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.staging.payrails.io/payment/payments/{paymentId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.staging.payrails.io/payment/payments/{paymentId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.staging.payrails.io/payment/payments/{paymentId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "fe67fc45-ce47-4fc8-a283-22d03ae68b77",
  "status": "Authorized",
  "createdAt": "2022-04-22T17:53:36.814Z",
  "providerId": "e96aa893-4458-43c6-b334-179cf73f5dba",
  "providerName": "adyen",
  "providerReference": "adyen-6389361285",
  "providerConfigId": "5cc8f271-0059-43a3-b339-27712c997e30",
  "holderId": "785380c9-1015-453d-82ab-d3386e27c05e",
  "workspaceId": "7f9f1882-a103-408d-ac96-46a7021e537a",
  "amount": {
    "value": "22.40",
    "currency": "EUR"
  },
  "instrumentId": "15b0069a-913b-4224-b05a-056e89611a51",
  "instrumentTokenId": "38fa0ee2-3f6e-41c1-8298-7398b2a93bd3",
  "instrument": {
    "id": "15b0069a-913b-4224-b05a-056e89611a51",
    "holderId": "788c7c09-a490-4603-915a-e2a957a6cca1",
    "createdAt": "2022-04-22T17:53:36.814Z",
    "updatedAt": "2022-04-22T17:53:36.814Z",
    "paymentMethod": "card",
    "description": "Personal card.",
    "fingerprint": "739abff0-406a-4d32-8cfb-701e12be5848",
    "status": "created",
    "futureUsage": "CardOnFile",
    "data": {
      "network": "visa",
      "bin": "411111",
      "suffix": "1111",
      "expiryMonth": "10",
      "expiryYear": "2026",
      "holderName": "John Doe"
    },
    "meta": {
      "communityCode": "GAP",
      "userKey": "9890124569"
    }
  },
  "transactionReference": "order-671934582",
  "transactionElementReference": "wkf-24-64313",
  "pspRedirectUrl": "",
  "merchantReturnUrl": "http://merchant.com/redirect-from/def456",
  "merchantReference": "468b618d77ed",
  "history": [
    {
      "id": "7314d8ea-ad96-4564-a954-8fc17584823b",
      "createdAt": "2022-04-22T17:53:56.631Z",
      "paymentId": "fe67fc45-ce47-4fc8-a283-22d03ae68b77",
      "type": "Authorize",
      "providerReference": "adyen-auth-6389361285",
      "amount": {
        "value": "22.40",
        "currency": "EUR"
      },
      "result": "Success",
      "responseCode": "Authorised",
      "log": [
        {
          "id": "35773ce1-a5d6-41f4-a94f-3005ac12f8bf",
          "createdAt": "2022-04-22T17:53:56.721Z",
          "operationId": "7314d8ea-ad96-4564-a954-8fc17584823b",
          "request": "{\n  \"amount\": {\n    \"currency\": \"EUR\",\n    \"value\": 2240\n  },\n  \"reference\": \"fe67fc45-ce47-4fc8-a283-22d03ae68b77\",\n  \"paymentMethod\": {\n    \"type\": \"scheme\",\n    \"number\": \"***REDACTED***\",\n    \"expiryMonth\": \"03\",\n    \"expiryYear\": \"2030\",\n    \"holderName\": \"John Smith\",\n    \"cvc\": \"***REDACTED***\"\n  },\n  \"returnUrl\": \"http://payrails.com/redirect-from/def456\",\n  \"merchantAccount\": \"MERCHANT_ACCOUNT\"\n}\n",
          "response": "{\n  \"additionalData\": {\n    \"scaExemptionRequested\": \"transactionRiskAnalysis\"\n  },\n  \"pspReference\": \"adyen-6389361285\",\n  \"resultCode\": \"Authorised\",\n  \"amount\": {\n    \"currency\": \"EUR\",\n    \"value\": 2240\n  },\n  \"merchantReference\": \"fe67fc45-ce47-4fc8-a283-22d03ae68b77\"\n}\n"
        }
      ]
    }
  ]
}

GET

https://api.staging.payrails.io

payment

payments

{paymentId}

Get payment by ID

curl --request GET \
  --url https://api.staging.payrails.io/payment/payments/{paymentId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.staging.payrails.io/payment/payments/{paymentId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.staging.payrails.io/payment/payments/{paymentId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.staging.payrails.io/payment/payments/{paymentId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.staging.payrails.io/payment/payments/{paymentId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.staging.payrails.io/payment/payments/{paymentId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "fe67fc45-ce47-4fc8-a283-22d03ae68b77",
  "status": "Authorized",
  "createdAt": "2022-04-22T17:53:36.814Z",
  "providerId": "e96aa893-4458-43c6-b334-179cf73f5dba",
  "providerName": "adyen",
  "providerReference": "adyen-6389361285",
  "providerConfigId": "5cc8f271-0059-43a3-b339-27712c997e30",
  "holderId": "785380c9-1015-453d-82ab-d3386e27c05e",
  "workspaceId": "7f9f1882-a103-408d-ac96-46a7021e537a",
  "amount": {
    "value": "22.40",
    "currency": "EUR"
  },
  "instrumentId": "15b0069a-913b-4224-b05a-056e89611a51",
  "instrumentTokenId": "38fa0ee2-3f6e-41c1-8298-7398b2a93bd3",
  "instrument": {
    "id": "15b0069a-913b-4224-b05a-056e89611a51",
    "holderId": "788c7c09-a490-4603-915a-e2a957a6cca1",
    "createdAt": "2022-04-22T17:53:36.814Z",
    "updatedAt": "2022-04-22T17:53:36.814Z",
    "paymentMethod": "card",
    "description": "Personal card.",
    "fingerprint": "739abff0-406a-4d32-8cfb-701e12be5848",
    "status": "created",
    "futureUsage": "CardOnFile",
    "data": {
      "network": "visa",
      "bin": "411111",
      "suffix": "1111",
      "expiryMonth": "10",
      "expiryYear": "2026",
      "holderName": "John Doe"
    },
    "meta": {
      "communityCode": "GAP",
      "userKey": "9890124569"
    }
  },
  "transactionReference": "order-671934582",
  "transactionElementReference": "wkf-24-64313",
  "pspRedirectUrl": "",
  "merchantReturnUrl": "http://merchant.com/redirect-from/def456",
  "merchantReference": "468b618d77ed",
  "history": [
    {
      "id": "7314d8ea-ad96-4564-a954-8fc17584823b",
      "createdAt": "2022-04-22T17:53:56.631Z",
      "paymentId": "fe67fc45-ce47-4fc8-a283-22d03ae68b77",
      "type": "Authorize",
      "providerReference": "adyen-auth-6389361285",
      "amount": {
        "value": "22.40",
        "currency": "EUR"
      },
      "result": "Success",
      "responseCode": "Authorised",
      "log": [
        {
          "id": "35773ce1-a5d6-41f4-a94f-3005ac12f8bf",
          "createdAt": "2022-04-22T17:53:56.721Z",
          "operationId": "7314d8ea-ad96-4564-a954-8fc17584823b",
          "request": "{\n  \"amount\": {\n    \"currency\": \"EUR\",\n    \"value\": 2240\n  },\n  \"reference\": \"fe67fc45-ce47-4fc8-a283-22d03ae68b77\",\n  \"paymentMethod\": {\n    \"type\": \"scheme\",\n    \"number\": \"***REDACTED***\",\n    \"expiryMonth\": \"03\",\n    \"expiryYear\": \"2030\",\n    \"holderName\": \"John Smith\",\n    \"cvc\": \"***REDACTED***\"\n  },\n  \"returnUrl\": \"http://payrails.com/redirect-from/def456\",\n  \"merchantAccount\": \"MERCHANT_ACCOUNT\"\n}\n",
          "response": "{\n  \"additionalData\": {\n    \"scaExemptionRequested\": \"transactionRiskAnalysis\"\n  },\n  \"pspReference\": \"adyen-6389361285\",\n  \"resultCode\": \"Authorised\",\n  \"amount\": {\n    \"currency\": \"EUR\",\n    \"value\": 2240\n  },\n  \"merchantReference\": \"fe67fc45-ce47-4fc8-a283-22d03ae68b77\"\n}\n"
        }
      ]
    }
  ]
}

Authorizations

Authorization

string

header

required

You can use an OAuth2 JWT bearer token in the Authorization header of your API requests for supported endpoints: Authorization: Bearer <YOUR_JWT_HERE>. These tokens are valid for 10 minutes and can be requested via the access token endpoint endpoint.

Path Parameters

paymentId

string<uuid>

required

Identifier of the resource in Payrails.

Query Parameters

includeInstrument

boolean

default:false

Boolean indicating if the payment instrument should be included in the response.

includePaymentToken

boolean

default:false

Boolean indicating if the instrument payment token should be included in the response.

includeProviderAccountDisplayName

boolean

default:false

Boolean indicating if the provider account display name should be included in the response.

includeHolderReference

boolean

default:false

Boolean indicating if the holder reference should be included in the response.

Response

Payment entity found, and all details are included.

string<uuid>

required

Unique identifier of the Payment in Payrails.

status

enum<string>

required

Current status of the Payment in Payrails. More information can be found here.

Available options:

Created,

Pending,

Unknown,

Failed,

Expired,

Preauthorized,

Authorized,

Canceled,

Captured,

Refunded

createdAt

string<date-time>

Exact date and time when the Payment was created in Payrails. Possibly differs slightly from the date in the PSP.

providerId

string<uuid>

Unique identifier of the Provider that was used to process the Payment.

paymentMethodType

string

Type of payment method used to process the payment.

providerIntegrationType

string

Type of integration used to process the payment (in case the payment provider supports multiple).

providerName

string

Name of the Provider that was used to process the Payment, e.g. Adyen, Checkout, Stripe.

providerReference

string

Unique identifier of the Payment in an external system, e.g. PSP.

providerConfigId

string<uuid>

Unique identifier of the merchant-specific Provider Configuration that was used to process the Payment. This can include the set of credentials used, the merchant account, country, vertical, etc.

holderId

string<uuid>

Unique identifier of the Holder that is involved in the Payment.

amount

object

Amount of the Payment.

Hide child attributes

amount.value

string

required

Decimal amount of the major currency unit. Can be any precision.

Pattern: [0-9]+(\.[0-9]+)?

Example:

"12.50"

amount.currency

string

required

ISO 3-letter currency code.

Pattern: ^[A-Z]{3}$

Example:

"EUR"

instrumentId

string<uuid>

Unique identifier of the Instrument that was used for the Payment in Payrails.

instrumentTokenId

string<uuid>

Unique identifier of the specific Token inside the Instrument used for the Payment in Payrails.

instrument

object

Optionally included details about the instrument used for the payment.

Hide child attributes

instrument.id

string<uuid>

required

Id of the instrument.

instrument.createdAt

string<date-time>

required

Date and time when the Instrument was created in Payrails.

instrument.updatedAt

string<date-time>

required

When the Instrument was last updated.

instrument.holderId

string<uuid>

required

Unique identifier of the Holder in Payrails.

instrument.paymentMethod

enum<string>

required

Represents the payment method type.

Available options:

alexBankMa7fazty,

applePay,

audi2pay,

bankAccount,

card,

2c2p,

vietQR,

cibSmartWallet,

easypaisa,

etisalatCash,

fawryMobileWallet,

fawryPay,

googlePay,

jazzCash,

nbePhoneCash,

orangeCash,

payPal,

qnbEWallet,

weCash,

genericRedirect,

alfa,

konnect,

eftPro,

netBanking,

upi,

cashFreeWallet,

paytmWallet,

phonePe,

iDeal,

bancontact,

klarnaPayLater,

klarnaPayNow,

klarnaPayOverTime,

scalapay

instrument.status

enum<string>

required

Status of the instrument.

Available options:

created,

deleted,

enabled,

disabled,

transient

instrument.displayName

string

Instrument name suitable for display.

instrument.description

string

Description of the instrument.

instrument.default

boolean | null

True if this instrument is set as default for the holder.

instrument.merchantReference

string

Merchant-provided reference for the instrument.

instrument.fingerprint

string

System-wide unique identifier of the Instrument. If two Holders have the same instrument stored, this value will be the same for both, but the instrument and token IDs will be different. Cannot be used for payments, should only be used for analytics and fraud prevention.

instrument.futureUsage

enum<string>

Represents the future usage to define the payment flows that the stored instrument will be used for.

Available options:

Subscription,

CardOnFile,

UnscheduledCardOnFile

instrument.networkTransactionReference

string

Identifier of the initial payment made with this instrument on the Networks, e.g. Mastercard Trace ID or Visa Transaction ID.

instrument.transactionLinkId

string

Mastercard Transaction Link Identifier (TLID) of the transaction series this instrument belongs to. Returned by the card network on the initial cardholder-initiated transaction and required on economically related merchant-initiated transactions, such as recurring payments and installments, when the series spans payment providers.

instrument.data

Card · object

Type-specific information about the instrument.

Hide child attributes

instrument.data.network

enum<string>

required

Network of the instrument.

Available options:

unspecified,

visa,

visadankort,

mastercard,

amex,

diners,

discover,

unionpay,

unionpayuzcard,

maestro,

maestrobancontact,

hipercard,

jcb,

jcblankapay,

argencard,

aura,

belkart,

bpfuelcard,

cabal,

carnet,

cirrus,

chjonesfuelcard,

uzcard,

codensa,

dankort,

dinacard,

duet,

ebt,

eftpos,

elo,

euroshellfuelcard,

gecapital,

bc,

hrgstore,

humo,

lankapay,

lukoilfuelcard,

bancontact,

meeza,

newday,

mir,

ourocard,

pagobancomat,

paypak,

paypal,

phhfuelcard,

prostir,

rupay,

sbercard,

sodexo,

starrewards,

cencosud,

naranja,

troy,

uatp,

ukfuelcard,

verve,

voyager,

vpay,

wex,

cmi,

atm,

bankcard,

localbrand,

loyalty,

privatelabel,

fuelcard,

redfuelcard,

redliquidfuelcard

instrument.data.bin

string

required

First 6-8 digits of the Card number. Also known as IIN (Issuer Identification Number).

Required string length: 6 - 8

Example:

"416598"

instrument.data.suffix

string

required

Last digits of the Card number.

Required string length: 4

instrument.data.preferredScheme

enum<string>

Network of the instrument.

Available options:

unspecified,

visa,

visadankort,

mastercard,

amex,

diners,

discover,

unionpay,

unionpayuzcard,

maestro,

maestrobancontact,

hipercard,

jcb,

jcblankapay,

argencard,

aura,

belkart,

bpfuelcard,

cabal,

carnet,

cirrus,

chjonesfuelcard,

uzcard,

codensa,

dankort,

dinacard,

duet,

ebt,

eftpos,

elo,

euroshellfuelcard,

gecapital,

bc,

hrgstore,

humo,

lankapay,

lukoilfuelcard,

bancontact,

meeza,

newday,

mir,

ourocard,

pagobancomat,

paypak,

paypal,

phhfuelcard,

prostir,

rupay,

sbercard,

sodexo,

starrewards,

cencosud,

naranja,

troy,

uatp,

ukfuelcard,

verve,

voyager,

vpay,

wex,

cmi,

atm,

bankcard,

localbrand,

loyalty,

privatelabel,

fuelcard,

redfuelcard,

redliquidfuelcard

instrument.data.binLookup

object

Information about an issuer by the given BIN (or IIN).

Hide child attributes

instrument.data.binLookup.bin

string

required

First 6-8 digits of the Card number. Also known as IIN (Issuer Identification Number).

Required string length: 6 - 8

Example:

"416598"

instrument.data.binLookup.network

enum<string>

Network of the instrument.

Available options:

unspecified,

visa,

visadankort,

mastercard,

amex,

diners,

discover,

unionpay,

unionpayuzcard,

maestro,

maestrobancontact,

hipercard,

jcb,

jcblankapay,

argencard,

aura,

belkart,

bpfuelcard,

cabal,

carnet,

cirrus,

chjonesfuelcard,

uzcard,

codensa,

dankort,

dinacard,

duet,

ebt,

eftpos,

elo,

euroshellfuelcard,

gecapital,

bc,

hrgstore,

humo,

lankapay,

lukoilfuelcard,

bancontact,

meeza,

newday,

mir,

ourocard,

pagobancomat,

paypak,

paypal,

phhfuelcard,

prostir,

rupay,

sbercard,

sodexo,

starrewards,

cencosud,

naranja,

troy,

uatp,

ukfuelcard,

verve,

voyager,

vpay,

wex,

cmi,

atm,

bankcard,

localbrand,

loyalty,

privatelabel,

fuelcard,

redfuelcard,

redliquidfuelcard

instrument.data.binLookup.localNetwork

enum<string>

Card local network that supports the card, e.g. CartesBancaires, Dankort, Mada, Bancontact.

Available options:

bancontact,

cartesbancaires,

dankort,

mada

instrument.data.binLookup.issuer

string

Name of the bank or institution that issued the card.

instrument.data.binLookup.issuerCountry

object

Country of the bank or institution that issued the card.

Hide child attributes

instrument.data.binLookup.issuerCountry.code

string

required

ISO 3166-1 alpha-2 country code.

Pattern: ^[A-Z]{2}$

instrument.data.binLookup.issuerCountry.iso3

string

ISO 3-letter country code. Returned by Payrails, but not interpreted in requests.

Pattern: ^[A-Z]{3}$

instrument.data.binLookup.issuerCountry.name

string

The English name of the country. Returned by Payrails, but not interpreted in requests.

instrument.data.binLookup.segment

string

Segment of the card, e.g. gold, black, business.

instrument.data.binLookup.type

string

Type of the card, e.g. credit, debit, prepaid, gift.

instrument.data.binLookup.typeDetails

string

More information about the card type, e.g. personal, commercial.

instrument.data.binLookup.isNetworkToken

boolean

Indicates whether the card credential represents a network token rather than a primary account number (PAN).

instrument.data.binLookup.isFlexCard

boolean

Indicates whether the card is enrolled in a Flexible Credential or Flex Card program supported by the network - e.g. Visa Flexible Credential, Mastercard FlexCard.

instrument.data.billingAddress

object

Billing Address of the instrument.

Hide child attributes

instrument.data.billingAddress.street

string

The name of the street of a postal address.

instrument.data.billingAddress.doorNumber

string

The number on the door, building, or room.

instrument.data.billingAddress.complement

string

Additional addressing information, 2nd line of postal address.

instrument.data.billingAddress.area

string

The name of the suburb or area within a city.

instrument.data.billingAddress.city

string

The name of the city of a postal address.

instrument.data.billingAddress.postalCode

string

The postal code.

instrument.data.billingAddress.state

string

The name of the state a postal address is in.

instrument.data.billingAddress.country

object

The country where the address is in.

Hide child attributes

instrument.data.billingAddress.country.code

string

required

ISO 3166-1 alpha-2 country code.

Pattern: ^[A-Z]{2}$

instrument.data.billingAddress.country.iso3

string

ISO 3-letter country code. Returned by Payrails, but not interpreted in requests.

Pattern: ^[A-Z]{3}$

instrument.data.billingAddress.country.name

string

The English name of the country. Returned by Payrails, but not interpreted in requests.

instrument.data.billingAddress.latitude

number<float>

Latitude of the address in the GPS coordinate system.

instrument.data.billingAddress.longitude

number<float>

Longitude of the address in the GPS coordinate system.

instrument.data.billingAddress.phone

object

The phone to contact in the address (can be different that the customer's).

Hide child attributes

instrument.data.billingAddress.phone.number

string

required

The local number of the phone, such that countryCode + number can be dialed.

Pattern: ^[0-9]+$

instrument.data.billingAddress.phone.countryCode

string

International prefix of the phone, if known separately.

Pattern: ^\+?[0-9]+$

instrument.data.billingAddress.alias

string

Name of the address, e.g. home, work.

instrument.data.billingAddress.name

string

Name of the person to whom the address belongs to.

instrument.data.billingAddress.lastName

string

Last name of the person to whom the address belongs to.

instrument.data.billingAddress.email

string

Email of the person to whom the address belongs to.

instrument.data.expiryMonth

string

Expiry month of the Card.

Required string length: 2

instrument.data.expiryYear

string

Expiry year of the Card.

Required string length: 4

instrument.data.holderName

string

Name of the owner of the Card.

instrument.data.taxId

string

Payer-provided tax identification number (e.g. CPF in Brazil) collected on the instrument.

instrumentToken

object

Optionally included details about the instrument token used for the payment.

Hide child attributes

instrumentToken.id

string<uuid>

required

Id of the token in Payrails.

instrumentToken.createdAt

string<date-time>

required

Date and time when the Token was created in Payrails.

instrumentToken.updatedAt

string<date-time>

required

When the Token was last updated.

instrumentToken.instrumentId

string<uuid>

required

Id of the payment instrument the token belongs to.

instrumentToken.status

enum<string>

required

Status of the token.

Available options:

created,

enabled,

disabled,

deleted

instrumentToken.type

enum<string>

required

Type of the token.

Available options:

network,

vault,

psp,

networkOffers,

networkGateway

instrumentToken.providerId

string<uuid>

required

Id of the provider the token belongs to.

instrumentToken.reference

string

required

Unique identifier of the token in the provider's system.

instrumentToken.providerConfigId

string<uuid>

Id of the configuration in the provider the token belongs to.

instrumentToken.meta

object

Any merchant or provider-specific data that should be stored for context in the token.

transactionReference

string

Merchant-specific identifier of the execution. This can be used for searching for the Payment later.

transactionElementReference

string

Identifier of the step in the Workflow that led to this Payment.

pspRedirectUrl

string

In case a redirection process is needed during the Payment, this is the URL where the PSP requested Payrails to redirect the user to.

capturedAmount

object

Amount that was captured from the Payment. If no capture is initiated for the payment, the value will be 0 until a successful capture occurs.

Hide child attributes

capturedAmount.value

string

required

Decimal amount of the major currency unit. Can be any precision.

Pattern: [0-9]+(\.[0-9]+)?

Example:

"12.50"

capturedAmount.currency

string

required

ISO 3-letter currency code.

Pattern: ^[A-Z]{3}$

Example:

"EUR"

refundedAmount

object

Amount that was refunded from the Payment. If multiple partial refunds have been made, this will be the sum of them. If no refund is initiated for the payment, the value will remain 0 until a successful refund occurs.

Hide child attributes

refundedAmount.value

string

required

Decimal amount of the major currency unit. Can be any precision.

Pattern: [0-9]+(\.[0-9]+)?

Example:

"12.50"

refundedAmount.currency

string

required

ISO 3-letter currency code.

Pattern: ^[A-Z]{3}$

Example:

"EUR"

availableAmount

object

Amount still available to refund from the Payment, i.e. capturedAmount minus refundedAmount. Reflects partial captures, so refunds are never allowed to exceed what was actually captured.

Hide child attributes

availableAmount.value

string

required

Decimal amount of the major currency unit. Can be any precision.

Pattern: [0-9]+(\.[0-9]+)?

Example:

"12.50"

availableAmount.currency

string

required

ISO 3-letter currency code.

Pattern: ^[A-Z]{3}$

Example:

"EUR"

merchantReturnUrl

string

In case a redirection process is needed during the Payment, Payrails will return to this merchant-specific URL after it finished.

merchantReference

string

Merchant-provided reference for the Execution. Commonly, the identifier of the order on the Merchant's system.

Payrails API Reference

Get started

Workflow

Payment

Provider

Merchant

Vault

Analytics

Reporting

Reconciliation

Dispute

Get payment by ID

Authorizations

Path Parameters

Query Parameters

Response