Payments

Transactions
Buyers
Checkout Sessions
Payment links
Payment options
Payouts
Refunds
Sessions
Settlement records

Instruments

Card schemes
Digital wallets
Gift cards
Payment methods
Payment method definitions

Vault

Account updater
- POST
  Create a job
Network tokens
Payment service tokens
Vault Forward
Vault Forward endpoints
Vault Forward authentication

Connections

All services
Payment services
Digital wallets
Anti-fraud services

Dashboard

Flow
Reports
Report executions

Errors

Account updater

Create Account Updater job

Creates an Account Updater job.

A request is submitted to a third-party service, containing inquiries for a given set of payment methods. The job is not processed right away, but once created, it will store new card details automatically, if there are, when results are ready.

A payment method is considered for the job if the following conditions are met:

It exists.
It’s in a valid state: status is either succeeded or processing.
It corresponds to a card: method is card.
Its scheme is supported: scheme is amex, discover, mastercard or visa.
It doesn’t have an in-progress inquiry already.

The endpoint works in a best-efforts basis and it doesn’t return any error when a payment method doesn’t qualify for an inquiry. To determine what payment methods were considered for the job, an inquiries field, returned in the response body, contains the submitted inquiries. If none of the payment methods qualified for an inquiry, the job is not created and a 204 No Content status code is returned.

POST

account-updater

jobs

curl --request POST \
  --url https://api.{gr4vy_id}.gr4vy.app/account-updater/jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "payment_method_ids": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ]
}'

{
  "type": "account-updater-job",
  "id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
  "merchant_account_id": "default",
  "created_at": "2023-07-26T19:23:00.000+00:00",
  "updated_at": "2023-07-26T19:23:00.000+00:00",
  "inquiries": [
    {
      "type": "account-updater-inquiry",
      "id": "d038f8bf-f1fd-45b3-9948-e1fbb58e8d62",
      "payment_method_id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
  ]
}

This endpoint requires the payment-methods.write scope.

Authorizations

Authorization

string

header

required

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

Body

application/json

A request to create an Account Updater job.

payment_method_ids

string[]

required

A list of unique payment method identifiers used to create the Account Updater job. A payment method will be considered only if it qualifies for an inquiry.

Response

201

application/json

Returns the created Account Updater job.

An Account Updater job.

type

enum<string>

The type of this resource. Is always account-updater-job.

Available options:

account-updater-job

string

The unique identifier for this Account Updater job.

merchant_account_id

string

The unique ID for a merchant account.

created_at

string

The date and time when this Account Updater job was created.

updated_at

string

The date and time when this Account Updater job was last updated.

inquiries

object[]

A list of inquiries associated with this Account Updater job.

An Account Updater inquiry summary.

Was this page helpful?

Suggest edits

List payment method definitions Get network tokens

curl --request POST \
  --url https://api.{gr4vy_id}.gr4vy.app/account-updater/jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "payment_method_ids": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ]
}'

{
  "type": "account-updater-job",
  "id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
  "merchant_account_id": "default",
  "created_at": "2023-07-26T19:23:00.000+00:00",
  "updated_at": "2023-07-26T19:23:00.000+00:00",
  "inquiries": [
    {
      "type": "account-updater-inquiry",
      "id": "d038f8bf-f1fd-45b3-9948-e1fbb58e8d62",
      "payment_method_id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
  ]
}