Skip to main content
GET
/
Transaction
/
PaymentRequest
/
{paymentRequestId}
cURL
curl --request GET \
  --url https://api.trysynch.com/Transaction/PaymentRequest/{paymentRequestId} \
  --header 'Authorization: Bearer <token>'
{
  "externalPaymentRequestId": {
    "value": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "amount": {
    "value": 123,
    "currencyCode": {
      "value": "<string>",
      "displayName": "<string>",
      "cultureName": "<string>"
    }
  },
  "creationDate": {
    "value": "2023-11-07T05:31:56Z"
  },
  "dueDate": {
    "value": "2023-11-07T05:31:56Z"
  },
  "recipientName": "<string>",
  "recipientAddress": {
    "streetNumberAndName": "<string>",
    "apartmentNumber": "<string>",
    "city": "<string>",
    "zipCode": "<string>",
    "state": "<string>",
    "country": "<string>"
  },
  "emailAddress": "<string>",
  "contactPhoneNumber": "<string>",
  "paymentType": "<string>",
  "transferId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "transferStatus": "<string>",
  "coveredFee": 123,
  "attachments": [
    {
      "id": "<string>",
      "name": "<string>",
      "contentType": "<string>"
    }
  ],
  "debitAuth": {
    "limit": 123
  }
}

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Use /auth/token to obtain access token. Enter 'Bearer' [space] and then your token in the text input below. Example: 'Bearer eyJhbGci...'

Path Parameters

​
paymentRequestId
string<uuid>
required

Response

OK

​
externalPaymentRequestId
object
​
amount
object
​
creationDate
object
​
dueDate
object
​
recipientName
string
​
recipientAddress
object
​
emailAddress
string
​
contactPhoneNumber
string | null
​
paymentType
string
​
transferId
string<uuid> | null
​
transferStatus
string | null
​
coveredFee
number<double> | null
​
attachments
object[]
​
debitAuth
object