Référence API de Split Capture

Split Capture utilise notre API Transactions qui représente les prêts Affirm accordés à l'utilisateur final. Vous pouvez utiliser cette API pour interagir avec les transactions via l'objet Transactions, afin de modifier l'état de cette transaction, de mettre à jour les métadonnées ou de récupérer des détails.

Points de terminaison
POST `v1/transactions`
POST `v1/transactions/id/capture`
POST `v1/transactions/id/void`
POST `v1/transactions/id/refund`
POST `v1/transactions/id/update`
GET `v1/transactions/id`

Autorisation

L'autorisation d'une transaction se produit après qu'un utilisateur a terminé le processus de paiement Affirm et retourne sur le site du commerçant. L'autorisation des frais génère un transaction_id qui sera utilisé pour le référencer à l'avenir. Vous devez autoriser une transaction pour le créer entièrement.

Point de terminaison

<https://api.affirm.com/api/v1/transactions>

Paramètres d'en-tête

Paramètre
Idempotency-Key `string` OBLIGATOIRE: Identifiants uniques pré-générés par le client et utilisés par le serveur pour reconnaître les appels successifs au même point d'extrémité. Ceci est requis pour Split Capture et encouragé pour la fonctionnalité de transaction unique.

Paramètres du corps

Paramètres
transaction_id `string` OBLIGATOIRE : jeton unique utilisé pour l'autorisation. Reçu au `user_confirmation_url`
order_id `string` Facultatif: identifie la commande dans le système de gestion des commandes du marchand à laquelle cette transaction correspond. Renvoyé dans la réponse uniquement si il est inclus dans la requête.
reference_id `string` Facultatif: un identifiant unique qui peut être associé à chaque événement de transaction et réconcilié avec le système d'enregistrement utilisé par le commerçant.

demande

curl https://sandbox.affirm.com/api/v1/transactions \
     -X POST \
     -u "<public_api_key>:<private_api_key>" \
     -H "Content-Type: application/json" \
     -H "Idempotency-Key: <idempotency_value>" \
     -d '{"transaction_id": "<checkout_token>","order_id": "<order_id_value>"}'

Réponse

"status": "authorized",
    "amount_refunded": 0,
    "provider_id": 1,
    "created": "2020-06-12T20:32:09Z",
    "order_id": "random",
    "checkout_id": "LBQFHCCGETZF21GY",
    "currency": "USD",
    "amount": 99999,
    "events": [
        {
            "currency": "USD",
            "amount": 99999,
            "type": "auth",
            "id": "95FD5182N72JJ20Y",
            "created": "2020-06-12T20:35:47Z"
        }
    ],
    "authorization_expiration": "2020-12-09T20:35:48Z",
    "id": "R1CN-7IIP"
}

Saisie

Capturer les fonds d'une transaction autorisée, comme pour une transaction par carte de crédit.

Point de terminaison

POST <https://api.affirm.com/api/v1/transactions/{transaction_id}/capture>

Paramètres d'en-tête

Paramètre
Idempotency-Key `string` OBLIGATOIRE: Identifiants uniques pré-générés par le client et utilisés par le serveur pour reconnaître les appels successifs au même point d'extrémité. Ceci est requis pour Split Capture et encouragé pour la fonctionnalité de transaction unique.

Paramètres de chemin

Paramètres
transaction_id `string` OBLIGATOIRE: un identifiant unique représentant la transaction. La valeur est une chaîne alphanumérique de 9 ou 12 caractères, selon qu’il s’agit d’un prêt à mensualités ou d’un bail, respectivement.

Paramètres du corps

Paramètres
montant `int32` OBLIGATOIRE: Transmettez le montant à saisir. Si vous voulez capturer 50,80 $, la valeur `amount` sera 5080.
order_id `string` Facultatif: identifie la commande dans le système de gestion des commandes du marchand à laquelle cette transaction correspond. Renvoyé dans la réponse uniquement si il est inclus dans la requête.
reference_id `string` Facultatif: un identifiant unique qui peut être associé à chaque événement de transaction et réconcilié avec le système d'enregistrement utilisé par le commerçant.
shipping_carrier `string` Facultatif: le transporteur maritime (par ex., « USPS ») utilisé pour expédier les articles.
shipping_confirmation `string` Facultatif: Le numéro de suivi de l'expédition.

demande

curl https://sandbox.affirm.com/api/v1/transactions/{transaction_id}/capture \
    -X POST \
    -u "<public_api_key>:<private_api_key>" \
    -H "Content-Type: application/json" \
    -H "Idempotency-Key: <idempotency_value>" \
    -d '{"amount":<enter_amount>, "order_id": "<order_id_value>", "shipping_carrier": "<carrier_value>", "shipping_confirmation": "<shipping_confirmation_value>"}'

Réponse

{
    "fee": 22,
    "created": "2020-06-12T20:38:18Z",
    "order_id": "R1CN-7IIP",
    "shipping_confirmation": "shipping_confirmation_id",
    "shipping_carrier": "UPS",
    "currency": "USD",
    "amount": 1000,
    "type": "split_capture",
    "id": "02PWU4FLAU07GYW4"
}

Annuler

Annuler une transaction autorisée.

Point de terminaison

POST <https://api.affirm.com/api/v1/transactions/{transaction_id}/void>

Paramètres d'en-tête

Paramètre
Idempotency-Key `string` OBLIGATOIRE: Identifiants uniques pré-générés par le client et utilisés par le serveur pour reconnaître les appels successifs au même point d'extrémité. Ceci est requis pour Split Capture et encouragé pour la fonctionnalité de transaction unique.

Paramètres de chemin

Paramètres
transaction_id `string` OBLIGATOIRE: un identifiant unique représentant la transaction. La valeur est une chaîne alphanumérique de 9 ou 12 caractères, selon qu’il s’agit d’un prêt à mensualités ou d’un bail, respectivement.

Paramètres du corps

Paramètres
amount `int32` OBLIGATOIRE : transmettez le montant à annuler. Si vous voulez annuler 50,80 $, la valeur `amount` sera 5080.
reference_id `string` Facultatif: un identifiant unique qui peut être associé à chaque événement de transaction et réconcilié avec le système d'enregistrement utilisé par le commerçant.

demande

curl https://sandbox.affirm.com/api/v1/transactions/{transaction_id}/void \
    -X POST \
    -u "<public_api_key>:<private_api_key>" \
    -H "Content-Type: application/json" \
    -H "Idempotency-Key: <idempotency_value>" \
    -d '{"amount":<enter_amount>}'

Réponse

{
    "currency": "USD",
    "amount": 2000,
    "type": "refund_voided",
    "id": "Y5NVH0OHZLHR20IA",
    "created": "2020-06-12T20:38:58Z"
}

remboursement

Rembourser une transaction.

Point de terminaison

POST <https://api.affirm.com/api/v1/transactions/{transaction_id}/refund>

Paramètres d'en-tête

Paramètre
Idempotency-Key `string` OBLIGATOIRE: Identifiants uniques pré-générés par le client et utilisés par le serveur pour reconnaître les appels successifs au même point d'extrémité. Ceci est requis pour Split Capture et encouragé pour la fonctionnalité de transaction unique.

Paramètres de chemin

Paramètres
transaction_id `string` OBLIGATOIRE: un identifiant unique représentant la transaction. La valeur est une chaîne alphanumérique de 9 ou 12 caractères, selon qu’il s’agit d’un prêt à mensualités ou d’un bail, respectivement.

Paramètres du corps

Paramètres
amount `int32` OBLIGATOIRE: transmettez le montant à rembourser. Si vous voulez rembourser 50,80 $, la valeur `amount` sera 5080.
reference_id `string` Facultatif: un identifiant unique qui peut être associé à chaque événement de transaction et réconcilié avec le système d'enregistrement utilisé par le commerçant.

demande

curl https://sandbox.affirm.com/api/v1/transactions/{transaction_id}/refund \
    -X POST \
    -u "<public_api_key>:<private_api_key>" \
    -H "Content-Type: application/json" \
    -H "Idempotency-Key: <idempotency_value>" \
    -d '{"amount":<enter_amount>}'

Réponse

{
    "created": "2020-06-12T20:40:54Z",
    "fee_refunded": 22,
    "currency": "USD",
    "amount": 1000,
    "type": "refund",
    "id": "DKJYFG2LYG264LGK"
}

Mettre à jour

Mettre à jour une transaction avec de nouvelles informations d’exécution ou de commande, telles que le numéro de suivi d’expédition, le transporteur ou l’identifiant de la commande.

Point de terminaison

POST <https://api.affirm.com/api/v1/transactions/{transaction_id}>

Paramètres de chemin

Paramètres
transaction_id `string` OBLIGATOIRE: un identifiant unique représentant la transaction. La valeur est une chaîne alphanumérique de 9 ou 12 caractères, selon qu’il s’agit d’un prêt à mensualités ou d’un bail, respectivement.

Paramètres du corps

Paramètres
order_id `string` Facultatif: identifie la commande dans le système de gestion des commandes du marchand à laquelle cette transaction correspond. Renvoyé dans la réponse uniquement si il est inclus dans la requête.
reference_id `string` Facultatif: un identifiant unique qui peut être associé à chaque événement de transaction et réconcilié avec le système d'enregistrement utilisé par le commerçant.
shipping `string` Facultatif: Un objet `Contact` contenant les renseignements d'expédition du client.
shipping_carrier `string` Facultatif: le transporteur maritime (par ex., « USPS ») utilisé pour expédier les articles.
shipping_confirmation `string` Facultatif: Le numéro de suivi de l'expédition.

demande

curl https://sandbox.affirm.com/api/v1/transactions/{transaction_id} \
	-X POST \
	-u "<public_api_key>:<private_api_key>" \
	-H "Content-Type: application/json" \
	-d '{"order_id": "JLKM4321", "shipping_carrier": "USPS", "shipping_confirmation": "1Z23223", "shipping": {"name":{ "full": "John Doe"}, "address": {"line1": "325 Pacific Ave", "state": "CA", "city": "San Francisco", "zipcode": "94111", "country": "USA"}}}'

Réponse

{
    "created": "2020-06-12T20:43:23Z",
    "order_id": "R1CN-7IIP",
    "shipping_confirmation": "shipping_confirmation_id_1591994603",
    "shipping_carrier": "UPS",
    "type": "update",
    "id": "L88BIOQTCQNP2JAZ"
}

Lire

Lire les informations de transaction, l’état actuel de la transaction et les données de paiement pour une ou plusieurs transactions. Ceci est utile pour mettre à jour vos enregistrements ou votre système de gestion des commandes avec les états de transaction actuels avant d'effectuer des actions dessus. Il vous permet également de garder votre système synchronisé avec Affirm si votre personnel gère manuellement les prêts dans le portail du commerçant.

Point de terminaison

GET <https://api.affirm.com/api/v1/transactions/{transaction_id}>

Paramètres de chemin

Paramètres
transaction_id `string` OBLIGATOIRE: un identifiant unique représentant la transaction. La valeur est une chaîne alphanumérique de 9 ou 12 caractères, selon qu’il s’agit d’un prêt à mensualités ou d’un bail, respectivement.

Paramètres de requête

Paramètres
expand `string` Ensemble d'objets séparés par des virgules associés à développer dans la réponse. Les valeurs valides sont : `events`

demande

curl https://sandbox.affirm.com/api/v1/transactions/{transaction_id} \
    -X GET \
    -u "<public_api_key>:<private_api_key>"

Réponse

{
    "status": "partially_refunded",
    "amount_refunded": 1000,
    "provider_id": 1,
    "created": "2020-06-12T20:32:09Z",
    "order_id": "R1CN-7IIP",
    "checkout_id": "LBQFHCCGETZF21GY",
    "currency": "USD",
    "amount": 99999,
    "events": [],
    "authorization_expiration": "2020-12-09T20:35:48Z",
    "id": "R1CN-7IIP"
}