Create payment request by card provider

Creates a payment request initiated by a card provider. This endpoint is used for card provider integrations to create payment requests with card provider references.

POST /payment-requests

Create payment request by card provider

cURL

curl --request POST \
  --url https://api.venlyfinance.com/v1/payment-requests \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cardProviderReference": {
    "type": "<string>",
    "referenceId": "<string>"
  },
  "paymentRequest": {
    "amount": 123,
    "currency": "<string>",
    "idempotencyKey": "<string>",
    "externalId": "<string>",
    "description": "<string>"
  }
}
'

400

{
  "success": false,
  "errors": [
    {
      "code": "VALIDATION_ERROR",
      "message": "The request contains invalid parameters."
    }
  ]
}

Authorizations

Authorization · string · header · required

OAuth2 client credentials flow. Token endpoints:

• Staging: https://login-staging.venly.io/auth/realms/VenlyFinance/protocol/openid-connect/token
• Production: https://login.venly.io/auth/realms/VenlyFinance/protocol/openid-connect/token

Body

application/json

cardProviderReference · object · required

Show child attributes

paymentRequest · object · required

Show child attributes

Response

201

application/json

Payment request created