POST

/payment-methods/{payment_method_id}/payment-service-tokens

curl --request POST \
  --url https://api.sandbox.{gr4vy_id}.gr4vy.app/payment-methods/{payment_method_id}/payment-service-tokens \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "payment_service_id": "a7d6b829-aea5-407d-ab7f-138784b5ad2c",
  "redirect_url": "https://example.com/callback",
  "security_code": "123"
}'
{
  "approval_url": "https://api.example.app.gr4vy.com/payment-methods/f4fb0dd1-4ff9-46fb-965e-11de34aa6806/approve",
  "created_at": "2021-01-01T12:34:00.000+00:00",
  "id": "d6ad71d5-6908-45d6-ab65-39c55475dd08",
  "payment_method_id": "9bdc4bc4-005e-4658-8eee-a309fc43cd4d",
  "payment_service_id": "50f2e61f-caac-4e12-8d79-30eaf8250423",
  "status": "succeeded",
  "token": "string",
  "type": "payment-service-token",
  "updated_at": "2021-01-01T12:34:00.000+00:00"
}

This endpoint requires the payment-methods.write scope.

Authorizations

Authorizationheaderrequired
string

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

payment_method_idrequired
string

The ID of the payment method.

Body

application/json
payment_service_idrequired
string

The ID of the payment service.

redirect_urlrequired
string

The redirect URL to redirect a buyer to after they have authorized their payment method. This only applies to payment methods that require buyer approval.

security_coderequired
string

The 3 or 4 digit security code often found on the card. This often referred to as the CVV or CVD.

The security code can only be set if the stored payment method represents a card.

Response

201 - application/json
approval_url
string | null

The optional URL that the buyer needs to be redirected to to further authorize their payment.

created_at
string

The date and time when this token was first created in our system.

id
string

The unique ID of the token.

payment_method_id
string

The unique ID of the payment method.

payment_service_id
string

The unique ID of the payment service.

status
enum<string>

The state of the token.

  • processing - The payment method is still being stored.
  • buyer_approval_required - Storing the payment method requires the buyer to provide approval. Follow the approval_url for next steps.
  • succeeded - The payment method is approved and stored with all relevant payment services.
  • failed - Storing the payment method did not succeed.
Available options:
processing,
buyer_approval_required,
succeeded,
failed
token
string

The token value.

type
enum<string>

The type of this resource.

Available options:
payment-service-token
updated_at
string

The date and time when this token was last updated in our system.