v1

latestOpenAPI 3.0.22026-08-061303782.1 MB

Payment Instruments

Verify Push-to-Card Eligibility

Determine Push To Card eligibility for Push To Card customers.

Additionally, the cardholder's name is verified with the issuing bank, and the result is shown in name_verification_results. This applies to Visa and Mastercard.

post/payment_instruments/{payment_instrument_id_verify}/verifications

Request body

processor'DUMMY_V1' | 'FINIX_V1' required

The acquiring processor. Use DUMMY_V1 to use your sandbox. For more details on which processor to use, reach out to your Finix point of contact or email Finix Support.

Response

A single Verification.

idstring

The ID of the resource.

created_atstring date-time

Timestamp of when the object was created.

updated_atstring date-time

Timestamp of when the object was last updated.

applicationstring

ID of the Application the resource was created under.

identitystring nullable

This field is not applicable to payment instrument verification.

merchantstring nullable

This field is not applicable to payment instrument verification.

merchant_identitystring nullable

This field is not applicable to payment instrument verification.

messagesstring[]

A codified list of reasons the verification request failed.

outcome_summarystring nullable

A message providing additional context about why the verification request failed.

outcomesobject[] nullable

A codified list of reasons the verification request failed.

payment_instrumentstring

The Payment Instrument sent for verification.

processor'FINIX_V1' | 'DUMMY_V1'

Name of the verification processor.

state'PENDING' | 'FAILED' | 'SUCCEEDED'

The state of the payment instrument verification request.

tagsTags nullable

Include up to 50 key: value pairs to annotate requests with custom metadata.

Maximum character length for individual keys is 40.
Maximum character length for individual values is 500. (For example, order_number: 25, item_type: produce, department: sales)

trace_idstring

An ID used for tracking the verification request.

type'PAYMENT_INSTRUMENT'

Details the type of resource getting verified.